Docs suggestion: use "prepare" instead of "postinstall" #884

nathansmith · 2021-02-24T15:52:42Z

TL;DR = Suggestion for the documentation site

This is not a bug "issue," but I wanted to make a suggestion for the docs.

I think this could alleviate some confusion around postinstall and remove the necessity for pinst entirely.

Currently, the Husky v5 documentation reads like this.

To automatically have Git hooks enabled after install, edit package.json
// package.json
{
  "private": true,
  "scripts": {
    "postinstall": "husky install"
  }
}

Instead, that could be changed to this. Swap out posinstall for prepare.

Also, private does not matter because prepare runs the same regardless.

To automatically have Git hooks enabled after install, edit package.json
// package.json
{
  "scripts": {
    "prepare": "husky install"
  }
}

Longer explanation

I did a writeup for my coworkers, to explain our automated setup for configuring Husky v5.

Basically, this all runs via NPM with the prepare command and puts everything into place.

If this is helpful for the docs, feel free to repurpose it.

This prepare.js file runs after npm install, when pulling down dependencies.
{
  "scripts": {
    "prepare": "node ./scripts/prepare.js"
  }
}
Unlike postinstall, the prepare command does not run when a NPM package is installed as a dependency in another project.

Meaning, it will not run within a package when someone types this…

npm install your-npm-package

…to install it for their own project.

But it will run when working on your-npm-package and installing other dependencies locally. This replicates the behavior we had before with Husky v4.

Code within the prepare.js file looks like this.
// =======
// Import.
// =======

const { execSync } = require('child_process');
const { existsSync } = require('fs');

// ===========
// File paths.
// ===========

const FILE_COMMIT = './.husky/pre-commit';
const FILE_HUSKY = './.husky/_/husky.sh';

// =========
// Commands.
// =========

const CLI_COMMIT = 'npx husky add .husky/pre-commit "npx lint-staged"';
const CLI_HUSKY = 'npx husky install';

// ==============
// Husky install.
// ==============

if (!existsSync(FILE_HUSKY)) {
  global.console.log(CLI_HUSKY);
  execSync(CLI_HUSKY);
}

// ====================
// Add pre-commit hook.
// ====================

if (!existsSync(FILE_COMMIT)) {
  global.console.log(CLI_COMMIT);
  execSync(CLI_COMMIT);
}
Code within the conditional logic will create .husky/pre-commit if it does not yet exist.

That adds a snippet (instructions for Husky) at the top of the file, and then appends the actual text that we passed in.
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged

The text was updated successfully, but these errors were encountered:

blimmer · 2021-02-25T19:22:55Z

If this change is made to the docs, you'll probably also want to update the migration helper: https://github.com/typicode/husky-4-to-5/blob/30792c918d08c0ebb99e1ef8942d13be91b9dd3e/src/pkg.ts#L65

typicode · 2021-02-27T23:12:33Z

@nathansmith Looks great, thanks a lot for the suggestion and detailed explanation! 👍

typicode · 2021-03-01T02:27:24Z

I've updated docs, it's a better approach for npm/pnpm/yarn v1 👍
However it seems like Yarn v2 doesn't support prepare https://yarnpkg.com/advanced/lifecycle-scripts

typicode · 2021-03-02T05:15:02Z

I've added a dedicated section to the docs for Yarn v2.

Also husky init will detect Yarn v2 and use postinstall [+ pinst] instead of prepare.

Not required when Husky runs via prepare script (only for postinstall) Amends 76df9bd per typicode/husky#884 Signed-off-by: Roger Sheen <roger@infotexture.net>

See: typicode/husky#884

see typicode/husky#884

* refactor: updated husky and pretty-quick dependencies and updated to the new config storage model and removed husky and pretty-quick from packages/core, as this should be possible to get triggered from root * refactor: updated prettier dependency and removed rules "trailingComma": "es5" as this is the new default * fix: added missing comma * refactor: regenerated yarn.lock file * refactor(husky): made additional necessary changes for the installation as well as moved husky to the devDependencies, as defined by the software doc itself * refactor(pinst): remove that solution again see typicode/husky#884 * refactor(code): integrated prettier feedback that was enforced like this by eslint * refactor(husky): updated husky and added pinst Yarn 2 doesn't support prepare lifecycle script, so husky needs to be installed differently (this doesn't apply to Yarn 1 though) * Revert "refactor(husky): updated husky and added pinst" This reverts commit e834b42. * refactor(husky): updated husky Co-authored-by: Josef Bredreck <slime.games@outlook.de>

andresmatasuarez · 2021-08-05T22:33:26Z

There's an important caveat to the use of prepare (or postinstall for that matter) that's worth mentioning:

If you have installed husky as a devDependency (as is my case and is suggested in the official docs) and are running npm publish as part of a CI or release process or whatever, then it'd simply not work due to husky not found error.

I wouldn't want to resort to simply installing husky in the regular dependencies and I know there's a whole official section explaining ways to disable husky for specific environments, but I wanted to make people coming across this issue in the future aware of this finding

- https://github.com/typicode/husky/issues/884\#issuecomment-788594365

didn't work - typicode/husky#884 (comment)

david10sing · 2021-09-09T07:56:35Z

I have package A (components library) where I use husky with prepare and I have another repository (Package B) where I use package A (from private git repository) as well as husky with prepare.

During yarn install, it looks like yarn tries to install package A because it has a prepare script and also install other deps from package B. It appears both installs happen together and causes issues with overwritting cache.

patoi · 2021-10-09T08:04:44Z

I think the best solution to install deps for production, if you run npm ci --ignore-scripts --production
In this case, prepare will be ignored, and the husky devDeps doesn't break your build.

RTFM: https://docs.npmjs.com/cli/v7/commands/npm-ci#ignore-scripts

haoadoreorange · 2021-11-02T22:44:47Z

There's an important caveat to the use of prepare (or postinstall for that matter) that's worth mentioning:

If you have installed husky as a devDependency (as is my case and is suggested in the official docs) and are running npm publish as part of a CI or release process or whatever, then it'd simply not work due to husky not found error.

I wouldn't want to resort to simply installing husky in the regular dependencies and I know there's a whole official section explaining ways to disable husky for specific environments, but I wanted to make people coming across this issue in the future aware of this finding

I second this, the actual best approach even for yarn classic is to have it in postinstall and use pinst. You'll also save yourself some times if ever you move to yarn 2.

Maybe you should make this the recommended setup on the doc.

nextglabs · 2021-11-23T21:28:26Z

There's an important caveat to the use of prepare (or postinstall for that matter) that's worth mentioning:
If you have installed husky as a devDependency (as is my case and is suggested in the official docs) and are running npm publish as part of a CI or release process or whatever, then it'd simply not work due to husky not found error.
I wouldn't want to resort to simply installing husky in the regular dependencies and I know there's a whole official section explaining ways to disable husky for specific environments, but I wanted to make people coming across this issue in the future aware of this finding

I second this, the actual best approach even for yarn classic is to have it in postinstall and use pinst. You'll also save yourself some times if ever you move to yarn 2.

Maybe you should make this the recommended setup on the doc.

Running yarn publish --ignore-scripts seems to solve this issue.

For more information see: - typicode/husky#884

See typicode/husky#884

See typicode/husky#884 for context on use of prepare.

* Add CI workflows for PRs and publishing * Do not specify Chromium path - use default (bundled) * Scope npm to public @bbc * Add @bbc scope to package-lock.json * Do not build postinstall as this is done before publishing to npm * Ignore scripts on publish as prepare is only used for dev environment See typicode/husky#884 for context on use of prepare. * Fix typo --------- Co-authored-by: Tom Sadler <thomas.sadler@bbc.co.uk>

- when installing from a git url, tsc command needs to be in the "prepare" lifecycle script. - [when installing from a git url,] If the package being installed contains a prepare script, its dependencies and devDependencies will be installed, and the prepare script will be run, before the package is packaged and installed. - https://docs.npmjs.com/cli/v10/commands/npm-install - hexo uses prepare script to install husky git hook - typicode/husky#884 - Revert af212dd - Reapply 844a785

see typicode/husky#884

typicode mentioned this issue Mar 1, 2021

docs: prepare script instead of postinstall #890

Merged

infotexture added a commit to dita-ot/docs that referenced this issue Mar 2, 2021

Remove obsolete Husky dependency: pinst

88c76af

Not required when Husky runs via prepare script (only for postinstall) Amends 76df9bd per typicode/husky#884 Signed-off-by: Roger Sheen <roger@infotexture.net>

typicode closed this as completed Mar 3, 2021

typicode mentioned this issue Mar 3, 2021

v5: a better solution for open-source #868

Closed

afc163 mentioned this issue Mar 7, 2021

chore: upgrade husky to v6 ant-design/ant-design#29535

Merged

19 tasks

ravijayaramappa mentioned this issue Mar 8, 2021

chore: update dependencies salesforce/lwc#2260

Merged

chalkygames123 added a commit to chalkygames123/stylelint-config that referenced this issue Mar 20, 2021

ci: remove dependency pinst and use "prepare" instead of "postinstall"

c02cb1d

See: typicode/husky#884

mfranzke added a commit to mfranzke/patternlab-node that referenced this issue Mar 28, 2021

refactor(pinst): remove that solution again

b552401

see typicode/husky#884

jamesgeorge007 mentioned this issue Apr 18, 2021

chore: use prepare script to install git hooks nuxt/create-nuxt-app#773

Merged

This was referenced May 7, 2021

Postinstall prevents installation as a dependency esm-bundle/react-dom#152

Closed

Postinstall prevents installation as a dependency esm-bundle/react#147

Closed

aleks-elkin mentioned this issue Jul 7, 2021

Migrated to husky v7 and added a commitlint with GHA check for each PR Tradeshift/elements#353

Merged

AlexFBP mentioned this issue Aug 12, 2021

Actualizaciones udistrital/necesidades_cliente#252

Open

8 tasks

unicornware referenced this issue in flex-development/tutils Sep 4, 2021

fix(scripts): use husky-run init in postinstall script

bf4c32b

- https://github.com/typicode/husky/issues/884\#issuecomment-788594365

unicornware referenced this issue in flex-development/tutils Sep 4, 2021

fix(scripts): use husky-run init in postinstall script

812ae42

- https://github.com/typicode/husky/issues/884\#issuecomment-788594365

unicornware added a commit to flex-development/tutils that referenced this issue Sep 5, 2021

revert(scripts): husky-run init fix

694643f

didn't work - typicode/husky#884 (comment)

TheMcMurder mentioned this issue Nov 16, 2021

removing husky - fixes #152 esm-bundle/react-dom#273

Closed

benjaminpjones mentioned this issue Feb 17, 2022

TimeControlPicker.tsx: sanitize value of numeric inputs online-go/online-go.com#1714

Merged

typicode mentioned this issue Mar 12, 2022

preinstall? #1119

Closed

oplik0 mentioned this issue Apr 16, 2022

don't run husky install on projects depending on houdini HoudiniGraphql/houdini#278

Closed

enricoemiro added a commit to enricoemiro/mailer that referenced this issue May 10, 2022

fix: from postinstall to prepare

d2a30e4

For more information see: - typicode/husky#884

lyonbot mentioned this issue Aug 4, 2022

[Bug report] shall not install husky when install CherryMarkdown as dep Tencent/cherry-markdown#288

Closed

Banner-Keith mentioned this issue Aug 31, 2022

Husky dependency TexteaInc/json-viewer#12

Closed

pogist mentioned this issue Sep 14, 2022

Fix package installation error due to husky setup bitmovin/bitmovin-player-react-native#20

Merged

lnist added a commit to mangrovedao/mangrove-core that referenced this issue Nov 11, 2022

fix(pack): Re-add pinst as it is needed due to husky

fe6398d

See typicode/husky#884

lnist mentioned this issue Nov 11, 2022

fix(pack): Re-add pinst as it is needed due to husky mangrovedao/mangrove-core#75

Merged

lnist added a commit to mangrovedao/mangrove-core that referenced this issue Nov 11, 2022

fix(pack): Re-add pinst as it is needed due to husky (#75)

382d557

See typicode/husky#884

h-a-n-a mentioned this issue Mar 7, 2023

fix: fix postinstall issue on being installed as a dependency web-infra-dev/rspack#2074

Merged

ideriabin mentioned this issue Mar 16, 2023

Fix husky wojtekmaj/react-date-picker#564

Closed

nonoakij mentioned this issue May 22, 2023

skip husky install cam-inc/viron#654

Merged

1 task

tsadler1988 added a commit to bbc/lrud-spatial that referenced this issue Jun 29, 2023

Ignore scripts on publish as prepare is only used for dev environment

07a127b

See typicode/husky#884 for context on use of prepare.

yathomasi mentioned this issue Jul 17, 2023

Housekeeping iterative/link-check#50

Merged

trajan0x mentioned this issue Aug 1, 2023

try to fix router install synapsecns/sanguine#1201

Merged

typicode mentioned this issue Oct 15, 2023

recommend postinstall instead of prepare? #1309

Closed

amitdahan mentioned this issue Dec 4, 2023

fix: fix husky neondatabase/neonctl#127

Merged

HBSPS mentioned this issue May 14, 2024

feat: eslint, prettier, husky 적용 Rapiders/react-hooks#8

Merged

4 tasks

technophile-04 added a commit to scaffold-eth/create-eth that referenced this issue Jun 11, 2024

fix: add and configure pinst

ee3d051

see typicode/husky#884

technophile-04 mentioned this issue Jun 11, 2024

fix: add and configure pinst scaffold-eth/create-eth#46

Merged

anthony-j-castro mentioned this issue Jul 16, 2024

Installation error when using npm jorisre/react-screen-wake-lock#275

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs suggestion: use "prepare" instead of "postinstall" #884

Docs suggestion: use "prepare" instead of "postinstall" #884

nathansmith commented Feb 24, 2021 •

edited

Loading

blimmer commented Feb 25, 2021

typicode commented Feb 27, 2021

typicode commented Mar 1, 2021

typicode commented Mar 2, 2021

andresmatasuarez commented Aug 5, 2021

david10sing commented Sep 9, 2021

patoi commented Oct 9, 2021

haoadoreorange commented Nov 2, 2021 •

edited

Loading

nextglabs commented Nov 23, 2021

Docs suggestion: use "prepare" instead of "postinstall" #884

Docs suggestion: use "prepare" instead of "postinstall" #884

Comments

nathansmith commented Feb 24, 2021 • edited Loading

TL;DR = Suggestion for the documentation site

Longer explanation

blimmer commented Feb 25, 2021

typicode commented Feb 27, 2021

typicode commented Mar 1, 2021

typicode commented Mar 2, 2021

andresmatasuarez commented Aug 5, 2021

david10sing commented Sep 9, 2021

patoi commented Oct 9, 2021

haoadoreorange commented Nov 2, 2021 • edited Loading

nextglabs commented Nov 23, 2021

nathansmith commented Feb 24, 2021 •

edited

Loading

haoadoreorange commented Nov 2, 2021 •

edited

Loading